home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / ansi_sys.arc / NANSI.DOC < prev    next >
Internet Message Format  |  1986-10-14  |  9KB
  1. Date:     Thu, 13 Feb 86 18:27:23 PST
  2. From:     kegel%Juliet.Caltech.Edu@Hamlet.Caltech.Edu
  3. Subject:  New ANSI driver, part 1 of 2
  4.  
  5.  
  6. Hi, folks.  Here's my console driver; the files are pretty long, and
  7. I apologize for simply stringing them together, but I'm not sure how
  8. else it could be sent.  This letter contains the documentation, the
  9. assembled driver (in hex, for loading with DEBUG), and some examples
  10. of how to set DOS RAW mode.  The following letter contains the five
  11. or so source files.  The source files are only needed if you want to
  12. make changes, or hunt down features or bugs.
  13.  
  14. [INFO-IBMPC distributes files in source form only. The HEX files have
  15. been deleted. -ed]
  16.  
  17. I admit, the source is pretty ugly some places; but it works well enough
  18. for my purposes.
  19.  
  20. So let me know what y'all think.
  21.  
  22.         - Daniel Kegel
  23. nansi    - enhanced MS-DOS ansi console driver
  24.  
  25. SYNOPSIS
  26.     Include in \config.sys the line
  27.         device=nansi.sys
  28.  
  29. DESCRIPTION
  30.     Nansi.sys is a console driver which understands ANSI control
  31.     sequences. It has several advantages over ANSI.SYS (the driver
  32.     supplied with DOS):
  33.     1. It supports new escape sequences (see below).
  34.     2. It provides MUCH faster output under certain conditions.
  35.     3. It supports the 43-line mode of the EGA.
  36.     4. The darned bell is now 1/4 second instead of 1/2 second long.
  37.  
  38.     What a console driver does:
  39.     When you, for example, type
  40.         C:> type foo.txt
  41.     COMMAND.COM opens the file foo.txt, reads it, and writes it to
  42.     the console driver, which puts it up on the screen.
  43.  
  44.     Both ansi.sys and nansi.sys use IBM Video BIOS to control the screen.
  45.     However, nansi.sys bypasses BIOS if the screen is in a text mode; this
  46.     allows much faster operation under certain conditions.
  47.  
  48.     While putting text up on the screen, (n)ansi.sys keeps a lookout for
  49.     the escape character (chr(27), known as ESC); this character signals
  50.     the start of a terminal control sequence.
  51.     Terminal control sequences follow the format
  52.         ESC [ param; param; ...; param cmd
  53.     where
  54.         ESC    is the escape character chr$(27).
  55.         [    is the left bracket character.
  56.         param    is an ASCII decimal number, or a string in quotes.
  57.         cmd    is a case-specific letter identifying the command.
  58.     Usually, zero, one, or two parameters are given.  If parameters
  59.     are omitted, they usually default to 1; however, some commands
  60.     (KKR and DKOCT) treat the no-parameter case specially.
  61.     Spaces are not allowed between parameters.
  62.  
  63.     For example, both ESC[1;1H and ESC[H send the cursor to the home
  64.     position (1,1), which is the upper left.
  65.  
  66.     Either single or double quotes may be used to quote a string.
  67.     Each character inside a quoted string is equivalent to one numeric
  68.     parameter.  Quoted strings are normally used only for the Keyboard
  69.     Key Reassignment command.
  70.  
  71. Control Sequences
  72.     The following table lists the sequences understood by nansi.sys.
  73.     Differences between nansi.sys and the standard ansi.sys are marked
  74.     with a vertical bar (|).
  75.  
  76. Cursor Positioning
  77. Short    Long name        Format        Notes
  78. CUP    cursor position        ESC[y;xH    Sets cursor position.
  79. HVP    cursor position        ESC[y;xf    Same as CUP; not recommended.
  80. CUU    cursor up        ESC[nA        n = # of lines to move
  81. CUD    cursor down        ESC[nB
  82. CUF    cursor forward        ESC[nC        n = # of columns to move
  83. CUB    cursor backward        ESC[nD
  84. DSR    Device Status, Report!    ESC[6n        Find out cursor position.
  85. CPR    Cursor Position report    ESC[y;xR    Response to DSR, as if typed.
  86. SCP    Save Cursor Position    ESC[s        Not nestable.
  87. RCP    Restore Cursor Position ESC[u
  88.  
  89. Editing
  90. ED    Erase in Display    ESC[2J    Clears screen.
  91. EL    Erase in Line        ESC[K    Clears to end of line.
  92. IL  |    Insert Lines        ESC[nL    Inserts n blank lines at cursor line.
  93. DL  |    Delete Lines        ESC[nM    Deletes n lines including cursor line.
  94. ICH |    Insert Characters    ESC[n@    Inserts n blank chars at cursor.
  95. DCH |    Delete Characters    ESC[nP    Deletes n chars including cursor char.
  96.  
  97.  
  98. Mode-Setting
  99. SGR    Set Graphics Rendition    ESC[n;n;...nm    See character attribute table.
  100. SM    Set Mode        ESC[=nh        See screen mode table.
  101. RM    Reset Mode        ESC[=nl        See screen mode table.
  102. IBMKKR    Keyboard Key Reass.    ESC["string"p
  103.     The first char of the string gives the key to redefine; the rest
  104.     of the string is the key's new value.
  105.     To specify unprintable chars, give the ASCII value of the char
  106.     outside of quotes, as a normal parameter.
  107.     IBM function keys are two byte strings; see the IBM Basic manual.
  108.     For instance, ESC[0;";dir a:";13;p redefines function key 1 to
  109.     have the value "dir a:" followed by the ENTER key.
  110.       | If no parameters given, all keys are reset to their default values.
  111.  
  112. DKOCT | Output char translate    ESC[n;ny
  113.       | When first char is encountered in output request, it is replaced with
  114.       | the second char.  This might be useful for previewing text before
  115.       | sending it to a printer with a funny print wheel.
  116.       | If no parameters are given, all chars are reset to normal.
  117.  
  118.  
  119. Character Attributes
  120.     The Set Graphics Rendition command is used to select foreground
  121.     and background colors or attributes.
  122.     When you use multiple parameters, they are executed in sequence, and
  123.     the effects are cumulative.
  124.        Attrib code        Value
  125.         0        All attributes off (normal white on black)
  126.         1        Bold
  127.         4        Underline
  128.         5        Blink
  129.         7        Reverse Video
  130.         8        Invisible (but why?)
  131.         30-37        foregnd blk/red/grn/yel/blu/magenta/cyan/white
  132.         40-47        background
  133.  
  134. Screen Modes
  135.     The IBM BIOS supports several video modes; the codes given in the
  136.     BIOS documentation are used as parameters to the Set Mode command.
  137.       | (In bitmap modes, the cursor is simulated with a small blob (^V).)
  138.         Mode Code        Value
  139.         0        text 40x25 Black & White
  140.         1        text 40x25 Color
  141.         2        text 80x25 Black & White
  142.         3        text 80x25 Color
  143.         4        bitmap 320x200 4 bits/pixel
  144.         5        bitmap 320x200 1 bit/pixel
  145.         6        bitmap 640x200 1 bit/pixel
  146.         7        (cursor wrap kludge)
  147.         13 (EGA)    bitmap 320x200 4 bits/pixel ?
  148.         14 (EGA)    bitmap 640x200 4 bits/pixel
  149.         16 (EGA)    bitmap 640x350 4 bits/pixel
  150.     Mode 7 is an unfortunate kludge; Setting mode 7 tells the cursor
  151.     to wrap around to the next line when it passes the end of a line;
  152.     Resetting mode 7 tells the cursor to not wrap, but rather stay put.
  153.       | If your computer has the Enhanced Graphics Adaptor, modes between
  154.       | 8 and 15 are also supported; see the EGA BIOS for info.
  155.       | The EGA also lets you use a shorter character cell in text modes
  156.       | in order to squeeze 43 lines of text out of the 25-line text modes.
  157.       | To enter 43 line mode, set the desired 25-line text mode (0 to 3),
  158.       | then Set Mode 43.  For instance: ESC[=3h ESC[=43h.
  159.       | To exit 43 line mode, set the desired 25-line text mode again.
  160.       | Nansi.sys ignores mode 43 unless there is an EGA on your computer.
  161.  
  162. Faster Output
  163.       | Any program that sets the console to RAW mode, and buffers its
  164.       | output properly, can achieve extremely high screen update speeds in
  165.       | return for giving up the special functions of the keys ^C, ^S, and ^P.
  166.       | See IOCTL in the MS-DOS 3.x Technical Reference for more info.
  167.     Also, a small improvement in speed may be noticed with some
  168.     programs that use the DOS console in normal mode, as this driver
  169.     efficiently implements the (standard but undocumented) INT 29h
  170.     most-favored-device putchar used by DOS.
  171.  
  172. EXAMPLES
  173.     See the file setraw.doc for Macro Assembler, Lattice C,
  174.     and Microsoft C routines for entering and leaving raw mode.
  175.  
  176. BUGS
  177.     Insert and delete character do not work in graphics modes.
  178.     Graphics mode writing is slow.
  179.     The simulated cursor in graphics mode slows down single-char
  180.     writes by a factor of 3; it should be disable-able.
  181.     Does not support erase-to-end-of-screen and other useful functions.
  182.  
  183. Version
  184.     This version, 2.2, created February 1986.  Problems should
  185.     be reported to Daniel Kegel, 1-60 CIT, Pasadena, CA 91126
  186.     (or, after June 1986, 2648 169th Ave SE, Bellevue, Wa. 98008).
  187.     Your suggestions for improvement would be most welcome.
  188.  
  189. NOTE
  190.     This program may be distributed for educational and personal use
  191.     only.  Commercial use is verboten; get in touch with the author.
  192.  
  193. FILES
  194.     nansi.doc    - this file
  195.     nansi.hex    - compiled version  <Not supported by INFO-IBMPC>
  196.         Convert nansi.hex into nansi.sys with the following commands
  197.         (you'll end up with 256 extra bytes at end, but who cares?):
  198.             debug            # Run DOS debugger
  199.             N nansi.hex        # Load the hex file
  200.             L
  201.             N nansi.sys        # Write it out
  202.             W
  203.             Q            # Quit- back to DOS.
  204.     nansi.cat    - concatenated sources
  205.         nansi    - makefile- shows how to assemble & link
  206.         nansi.asm    - device driver guts
  207.         nansi_d.asm    - definitions
  208.         nansi_p.asm    - ANSI parameter grabber
  209.         nansi_f.asm    - ANSI function handlers
  210.         nansi_i.asm    - device driver init routine
  211.     setraw.cat    - concatenated examples
  212.         setraw.asm    - for assembly programs
  213.         setraw.msc    - for Microsoft C programs
  214.         setraw.lc    - for Lattice C programs
  215.         rawtest.lc    - example for Lattice C only
  216.